5.8 Estorno de boletos

O endpoint de estorno permite reverter uma cobrança registrada anteriormente, informando o valor a ser devolvido, a data e o motivo do estorno. É possível identificar a cobrança tanto pelo id quanto pelo refId.

Request

Request

mutation RefundBilling {
    refundBilling(
        data: {
            id: 192
            refundValue: 5.00
            refundDate: "2025-10-28T00:00:00.000-03:00"
            refundReason: ENROLLMENT_CANCELLATION
            refundDescription: "descrição"
            notes: null
        }
    )
}

Params

Parâmetro	Tipo	Descrição
data	RefundDataInput!	Dados para estorno da cobrança

Objeto RefundDataInput

Campo	Tipo	Descrição
refundValue	Decimal!	Valor estornado
refundDate	DateTime!	Data do estorno
refundReason	RefundReason!	Motivo do estorno
refundDescription	String	Descrição complementar do estorno
notes	String	Anotação
id	Int	Id da cobrança
refId	String	Id de referência da cobrança
auditData	AuditDataInput	Dados de auditoria do sistema integrado

Response

Response

{
    "data": {
        "refundBilling": true
    }
}

Result

Campo	Tipo	Descrição
refundBilling	Boolean!	Indica se o estorno foi realizado